<!DOCTYPE HTML>
<html>
	<head>
		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
		<title>Vec3D Class Reference</title>
		<meta id="xcode-display" name="xcode-display" content="render"/>
		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
		<meta name="generator" content="appledoc 2.2 (build 963)" />
	</head>
	<body>
		<header id="top_header">
			<div id="library" class="hideInXcode">
				<h1><a id="libraryTitle" href="../index.html">SFS2X API v1.3.7 </a></h1>
				<a id="developerHome" href="../index.html">gotoAndPlay() / A51 Integrated</a>
			</div>
			
			<div id="title" role="banner">
				<h1 class="hideInXcode">Vec3D Class Reference</h1>
			</div>
			<ul id="headerButtons" role="toolbar">
				<li id="toc_button">
					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
				</li>
				<li id="jumpto_button" role="navigation">
					<select id="jumpTo">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	
	
	
	
	<option value="tasks">Tasks</option>
	
	
	
	
	
	<option value="properties">Properties</option>
	
	<option value="//api/name/floatX">&nbsp;&nbsp;&nbsp;&nbsp;floatX</option>
	
	<option value="//api/name/floatY">&nbsp;&nbsp;&nbsp;&nbsp;floatY</option>
	
	<option value="//api/name/floatZ">&nbsp;&nbsp;&nbsp;&nbsp;floatZ</option>
	
	<option value="//api/name/intX">&nbsp;&nbsp;&nbsp;&nbsp;intX</option>
	
	<option value="//api/name/intY">&nbsp;&nbsp;&nbsp;&nbsp;intY</option>
	
	<option value="//api/name/intZ">&nbsp;&nbsp;&nbsp;&nbsp;intZ</option>
	
	
	
	
	<option value="class_methods">Class Methods</option>
	
	<option value="//api/name/vectorWithX:Y:">&nbsp;&nbsp;&nbsp;&nbsp;+ vectorWithX:Y:</option>
	
	<option value="//api/name/vectorWithX:Y:Z:">&nbsp;&nbsp;&nbsp;&nbsp;+ vectorWithX:Y:Z:</option>
	
	
	
	
	<option value="instance_methods">Instance Methods</option>
	
	<option value="//api/name/isFloat">&nbsp;&nbsp;&nbsp;&nbsp;- isFloat</option>
	
	
	
</select>
				</li>
			</ul>
		</header>
		<nav id="tocContainer" class="isShowingTOC">
			<ul id="toc" role="tree">
				
<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>




<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
	
</ul></li>





<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/floatX">floatX</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/floatY">floatY</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/floatZ">floatZ</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intX">intX</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intY">intY</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intZ">intZ</a></span></li>
	
</ul></li>



<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/vectorWithX:Y:">vectorWithX:Y:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/vectorWithX:Y:Z:">vectorWithX:Y:Z:</a></span></li>
	
</ul></li>



<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isFloat">isFloat</a></span></li>
	
</ul></li>


			</ul>
		</nav>
		<article>
			<div id="contents" class="isShowingTOC" role="main">
				<a title="Vec3D Class Reference" name="top"></a>
				<div class="main-navigation navigation-top">
					<ul>
	<li><a href="../index.html">Index</a></li>
	<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
				</div>
				<div id="header">
					<div class="section-header">
						<h1 class="title title-header">Vec3D Class Reference</h1>
					</div>		
				</div>
				<div id="container">	
					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<td class="specification-title">Inherits from</td>
	<td class="specification-value">NSObject</td>
</tr><tr>
	<td class="specification-title">Declared in</td>
	<td class="specification-value">Vec3D.h<br />Vec3D.m</td>
</tr>
						</tbody></table></div>
					
                    
                    
					
					<div class="section section-overview">
						<a title="Overview" name="overview"></a>
						<h2 class="subtitle subtitle-overview">Overview</h2>
						<p>The Vec3D object represents a position in a 2D or 3D space.</p>

<p>This class is used to express a position inside a virtual environment with no specific unit of measure (could be pixels, feet, meters, etc).</p>

<p>Positions along the X,Y,Z axes can be expressed as ints or floats. Although Objective-C can handle both ints and floats under the NSNumber class, SmartFoxServer 2X needs to recognize the specific types. For this reason we recommend to initialize the object with the proper literals to declare which type you are using.</p>

<p>For instance (x:@10, y:@10, z:@10) will use integers while (x:@10F, y:@10F, z:@10F) will use the same coordinates but with a floating point type.</p>

<p>Long and Doubles are not supported for this type of coordinate values.</p>

<p>See <a href="../Classes/SetUserPositionRequest.html">SetUserPositionRequest</a>, <a href="../Classes/MMORoom.html">MMORoom</a>, <a href="../Classes/MMOItem.html">MMOItem</a></p>
					</div>
					
					
					
					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						<h2 class="subtitle subtitle-tasks">Tasks</h2>
						
						
						
						

						<ul class="task-list">
							<li>
	<span class="tooltip">
		<code><a href="#//api/name/intX">&nbsp;&nbsp;intX</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/intY">&nbsp;&nbsp;intY</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/intZ">&nbsp;&nbsp;intZ</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/floatX">&nbsp;&nbsp;floatX</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/floatY">&nbsp;&nbsp;floatY</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/floatZ">&nbsp;&nbsp;floatZ</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/vectorWithX:Y:Z:">+&nbsp;vectorWithX:Y:Z:</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/vectorWithX:Y:">+&nbsp;vectorWithX:Y:</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isFloat">&ndash;&nbsp;isFloat</a></code>
	</span>
	
	
</li>
						</ul>
						
					</div>
					
					
					
					
					
					<div class="section section-methods">
						<a title="Properties" name="properties"></a>
						<h2 class="subtitle subtitle-methods">Properties</h2>
						
						<div class="section-method">
	<a name="//api/name/floatX" title="floatX"></a>
	<h3 class="subsubtitle method-title">floatX</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>The X coordinate as Float</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (readonly) NSNumber *floatX</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>The X coordinate as Float</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/floatY" title="floatY"></a>
	<h3 class="subsubtitle method-title">floatY</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>The Y coordinate as Float</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (readonly) NSNumber *floatY</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>The Y coordinate as Float</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/floatZ" title="floatZ"></a>
	<h3 class="subsubtitle method-title">floatZ</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>The Z coordinate as Float</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (readonly) NSNumber *floatZ</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>The Z coordinate as Float</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/intX" title="intX"></a>
	<h3 class="subsubtitle method-title">intX</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>The X coordinate as Integer</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (readonly) NSInteger intX</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>The X coordinate as Integer</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/intY" title="intY"></a>
	<h3 class="subsubtitle method-title">intY</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>The Y coordinate as Integer</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (readonly) NSInteger intY</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>The Y coordinate as Integer</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/intZ" title="intZ"></a>
	<h3 class="subsubtitle method-title">intZ</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>The Z coordinate as Integer</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (readonly) NSInteger intZ</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>The Z coordinate as Integer</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
					</div>
					
					
					
					<div class="section section-methods">
						<a title="Class Methods" name="class_methods"></a>
						<h2 class="subtitle subtitle-methods">Class Methods</h2>
						
						<div class="section-method">
	<a name="//api/name/vectorWithX:Y:" title="vectorWithX:Y:"></a>
	<h3 class="subsubtitle method-title">vectorWithX:Y:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>2D Constructor</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>+ (id)vectorWithX:(NSNumber *)<em>x</em> Y:(NSNumber *)<em>y</em></code></div>

    
	
	<div class="method-subsection arguments-section parameters">
		<h4 class="method-subtitle parameter-title">Parameters</h4>
		
		<dl class="argument-def parameter-def">
			<dt><em>x</em></dt>
			<dd><p>the x coordinate</p></dd>
		</dl>
		
		<dl class="argument-def parameter-def">
			<dt><em>y</em></dt>
			<dd><p>the y coordinate</p></dd>
		</dl>
		
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>2D Constructor</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/vectorWithX:Y:Z:" title="vectorWithX:Y:Z:"></a>
	<h3 class="subsubtitle method-title">vectorWithX:Y:Z:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>3D Constructor</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>+ (id)vectorWithX:(NSNumber *)<em>x</em> Y:(NSNumber *)<em>y</em> Z:(NSNumber *)<em>z</em></code></div>

    
	
	<div class="method-subsection arguments-section parameters">
		<h4 class="method-subtitle parameter-title">Parameters</h4>
		
		<dl class="argument-def parameter-def">
			<dt><em>x</em></dt>
			<dd><p>the x coordinate</p></dd>
		</dl>
		
		<dl class="argument-def parameter-def">
			<dt><em>y</em></dt>
			<dd><p>the y coordinate</p></dd>
		</dl>
		
		<dl class="argument-def parameter-def">
			<dt><em>z</em></dt>
			<dd><p>the z coordinate</p></dd>
		</dl>
		
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>3D Constructor</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
					</div>
					
					
					
					<div class="section section-methods">
						<a title="Instance Methods" name="instance_methods"></a>
						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
						
						<div class="section-method">
	<a name="//api/name/isFloat" title="isFloat"></a>
	<h3 class="subsubtitle method-title">isFloat</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Checks if the object uses Floating point or Integer values</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isFloat</code></div>

    
	
	
	
	<div class="method-subsection return">
		<h4 class="method-subtitle parameter-title">Return Value</h4>
		<p>YES if the floats are used.</p>
	</div>
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Checks if the object uses Floating point or Integer values</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">Vec3D.h</code><br />
	</div>				
	
	
</div>
						
					</div>
					
					
                    
                    
				</div>
				<div class="main-navigation navigation-bottom">
					<ul>
	<li><a href="../index.html">Index</a></li>
	<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
				</div>
				<div id="footer">
					<hr />
					<div class="footer-copyright">
						<p><span class="copyright">&copy; 2014 gotoAndPlay() / A51 Integrated. All rights reserved. (Last updated: 2014-10-13)</span><br />
						
						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 963)</a>.</span></p>
						
					</div>
				</div>
			</div>
		</article>
		<script type="text/javascript">
			function jumpToChange()
			{
				window.location.hash = this.options[this.selectedIndex].value;
			}
			
			function toggleTOC()
			{
				var contents = document.getElementById('contents');
				var tocContainer = document.getElementById('tocContainer');
				
				if (this.getAttribute('class') == 'open')
				{
					this.setAttribute('class', '');
					contents.setAttribute('class', '');
					tocContainer.setAttribute('class', '');
					
					window.name = "hideTOC";
				}
				else
				{
					this.setAttribute('class', 'open');
					contents.setAttribute('class', 'isShowingTOC');
					tocContainer.setAttribute('class', 'isShowingTOC');
					
					window.name = "";
				}
				return false;
			}
			
			function toggleTOCEntryChildren(e)
			{
				e.stopPropagation();
				var currentClass = this.getAttribute('class');
				if (currentClass == 'children') {
					this.setAttribute('class', 'children open');
				}
				else if (currentClass == 'children open') {
					this.setAttribute('class', 'children');
				}
				return false;
			}
			
			function tocEntryClick(e)
			{
				e.stopPropagation();
				return true;
			}
			
			function init()
			{
				var selectElement = document.getElementById('jumpTo');
				selectElement.addEventListener('change', jumpToChange, false);
				
				var tocButton = document.getElementById('table_of_contents');
				tocButton.addEventListener('click', toggleTOC, false);
				
				var taskTreeItem = document.getElementById('task_treeitem');
				if (taskTreeItem.getElementsByTagName('li').length > 0)
				{
					taskTreeItem.setAttribute('class', 'children');
					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
				}
				
				var tocList = document.getElementById('toc');
				
				var tocEntries = tocList.getElementsByTagName('li');
				for (var i = 0; i < tocEntries.length; i++) {
					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
				}
				
				var tocLinks = tocList.getElementsByTagName('a');
				for (var i = 0; i < tocLinks.length; i++) {
					tocLinks[i].addEventListener('click', tocEntryClick, false);
				}
				
				if (window.name == "hideTOC") {
					toggleTOC.call(tocButton);
				}
			}
			
			window.onload = init;
			
			// If showing in Xcode, hide the TOC and Header
			if (navigator.userAgent.match(/xcode/i)) {
				document.getElementById("contents").className = "hideInXcode"
				document.getElementById("tocContainer").className = "hideInXcode"
				document.getElementById("top_header").className = "hideInXcode"
			}
			
		</script>
	</body>
</html>